Base APIs
Create a new formula definition
| HTTP method | POST |
| URI | https://api.rambase.net/base/formula-definitions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 2492, version 1 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Title
Required/mandatory field
Title of the formula
>{String}</Title>Description
Description of the formula
This field is optional.
>{String}</Description>Formula
The formula may include numeric values, parenthesized expressions, parameters, and mathematical operators. The following operators are supported: + - * /.
This field is optional.
>{String}</Formula>Type
Type of formula
Applicable domain values can be found here
This field is optional.
>{String}</Type>Title
Required/mandatory field
Title of the formula
": "{String}",Description
Description of the formula
This field is optional.
": "{String}",Formula
The formula may include numeric values, parenthesized expressions, parameters, and mathematical operators. The following operators are supported: + - * /.
This field is optional.
": "{String}",Type
Type of formula
Applicable domain values can be found here
This field is optional.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
FormulaDefinitionId
Formula identifier
>{Integer}</FormulaDefinitionId>Status
Status of the formula
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Title
Title of the formula
>{String}</Title>TranslatedTitle
Title translated to selected language. If no translation exists, the english title will show
>{String}</TranslatedTitle>Description
Description of the formula
>{String}</Description>TranslatedDescription
Description translated to selected language. If no translation exists, the english description will show
>{String}</TranslatedDescription>Formula
The formula may include numeric values, parenthesized expressions, parameters, and mathematical operators. The following operators are supported: + - * /.
>{String}</Formula>Type
Type of formula
Possible domain values can be found here
>Scope
Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.
>{String}</Scope>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
>{Boolean}</IsPendingDeployment>FormulaDefinitionId
Formula identifier
": "{Integer}",Status
Status of the formula
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Title
Title of the formula
": "{String}",TranslatedTitle
Title translated to selected language. If no translation exists, the english title will show
": "{String}",Description
Description of the formula
": "{String}",TranslatedDescription
Description translated to selected language. If no translation exists, the english description will show
": "{String}",Formula
The formula may include numeric values, parenthesized expressions, parameters, and mathematical operators. The following operators are supported: + - * /.
": "{String}",Type
Type of formula
Possible domain values can be found here
": {Scope
Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.
": "{String}",IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
": "{Boolean}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 102747 HTTP 400 | Error in formula: {0} |
| Error 102697 HTTP 400 | A formula with that title already exists |